Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update for 1.19 #597

Open
wants to merge 28 commits into
base: habana_main
Choose a base branch
from

Conversation

PatrykWo
Copy link

@PatrykWo PatrykWo commented Dec 5, 2024

No description provided.

README_GAUDI.md Outdated

#### 1. Build and Install the stable version

Periodically, we are releasing vLLM to allign with Intel® Gaudi® software releases. The stable version is released with a tagg, and supports fully validated features and performance optimizations in Gaudi's [vLLM-fork](https://github.com/HabanaAI/vllm-fork). To install the stable release from [HabanaAI/vLLM-fork](https://github.com/HabanaAI/vllm-fork), run the following:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: tagg

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected

README_GAUDI.md Outdated
```{.console}
$ git clone https://github.com/HabanaAI/vllm-fork.git
$ cd vllm-fork
$ git checkout v1.19.0

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably will need to replace with proper tag like in v0.5.3.post1+Gaudi-1.18.0

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bartekkuncer please verify if that makes sense.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michalkuligowski makes a good point especially that in release note we provide instruction with the use of a tag, so this change will make these two consistent.

$ cd vllm
$ git clone https://github.com/HabanaAI/vllm-fork.git
$ cd vllm-fork
$ git checkout v1.19.0

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably will need to replace with proper tag like in v0.5.3.post1+Gaudi-1.18.0

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bartekkuncer please verify if that makes sense.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@michalkuligowski makes a good point especially that in release note we provide instruction with the use of a tag, so this change will make these two consistent.

README_GAUDI.md Outdated Show resolved Hide resolved
README_GAUDI.md Outdated Show resolved Hide resolved
@@ -11,7 +11,7 @@ Please follow the instructions provided in the [Gaudi Installation Guide](https:
- OS: Ubuntu 22.04 LTS
- Python: 3.10
- Intel Gaudi accelerator
- Intel Gaudi software version 1.18.0
- Intel Gaudi software version 1.19.0

## Quick start using Dockerfile
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It needs more explanation.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will you add it? @piotrbocian

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or explain what you have in mind so someone else can do it?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see how document is structured:

  1. Quick start using Dockerfile
  2. Build from source
    2.1 Environment verification
    2.2 Run Docker Image
    2.3 Build and Install vLLM

Questions:

  • is (1.) full alternative to (2.)? If so, I would add one liner as
  • "You can quickly set up vLLM using latest Intel Gaudi docker and vllm verson "
  • is (2.1 Env verification) common to (1.) and (2.)?

README_GAUDI.md Outdated Show resolved Hide resolved
kzawora-intel added a commit that referenced this pull request Dec 19, 2024
Merges #507 and #597, updates changelog and adds minor changes.

---------

Co-authored-by: Bartosz Kuncer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants